home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / telecomm / bbs / ftpcdrom_214.lha / ftp.doc < prev    next >
Text File  |  1994-07-30  |  10KB  |  257 lines

  1.                   FTP Simulator Door Version 2.11
  2.  
  3.   Introduction:
  4.  
  5.      With the advent of CD-ROM drives, the Citadel BBS needed a method
  6.      to access multiple directories and allow a user to transfer files
  7.      from the CD-ROM to their system.  This program allows a user to
  8.      change directory and yet is safe from the hacker.
  9.  
  10.      This program is shareware.  If you use it, you must send a small
  11.      donation to me.  The minimum amount is $10, if you find it more
  12.      valuable, feel free to send more.  If you decide not to use it
  13.      then please send me a mail message or a postcard and tell me why.
  14.  
  15.      Send all fees to:
  16.  
  17.         Custom Services
  18.         P.O. Box 254
  19.         Moorestown, NJ 08055
  20.  
  21.      Registered users will receive an updated version if they include
  22.      either a larger donation than the minimum, or a disk and postage.
  23.      Registration will get you a personalized registration key that will
  24.      eliminate the reminder.
  25.  
  26.  User Operation:
  27.  
  28.    A user runs the door from your BBS, or you run it from a CLI.  See the
  29.    USER.DOC file for an explination of the commands available.
  30.  
  31.  Installation
  32.  
  33.    This program requires the 2.04 ROM or later.  It will not run under
  34.    1.3.
  35.  
  36.    The program is simple to operate.  You copy it to a directory on your
  37.    path and setup the door entry to be:
  38.  
  39.  For Citadel:
  40.  
  41.  #door ftp ftp  in:  anyone  modem unlimited
  42.   File transfer Program.
  43.   <ctdl-aux: >ctdl-aux:  "%d" cd0: in:
  44.  
  45.  The program has the following arguments:
  46.  
  47.    ftp "user name"  <directory 1> <directory 2>  [DLG/FREE flag]
  48.  
  49.       user name is the name the user has on the BBS.  For Citadel use
  50.                 "%d".
  51.  
  52.       directory1 is the root directory the user is allowed to examine.
  53.                  This is the directory the user will start with.  The
  54.                  user can move into any sub directory in this directory.
  55.                  The user will not be allowed to move to other places.
  56.                  This can be on a floppy, HD, or any other file system
  57.                  type device.
  58.  
  59.       directory2 is the directory attached to the room you have the door
  60.                  attached to.  This way, when a user exits the door, the
  61.                  files retrieved with the GET command are ready to be
  62.                  downloaded.
  63.  
  64.                  At this time, when a user does a GET, the file is copied
  65.                  to this directory.
  66.  
  67.    DLG/FREE flag This is an optional flag that tells the program to
  68.                  create a tag file used by the DLG bbs program  If this
  69.                  argument is present it may be:
  70.  
  71.                  FREE -- This is a DLG BBS, the downloads are free.
  72.  
  73.                  DLG  -- This is a DLG BBS, the downloads are normal.
  74.  
  75.                  If this option is not present or is not one of these
  76.                  two items, the tagged files list will not get created.
  77.                  If you are not running DLG, leave it off
  78.  
  79.                  The tag file is made up of 90 byte records of the
  80.                  form:
  81.  
  82.                  struct Batch
  83.                    {
  84.                    char filename[40]; /* filename */
  85.                    char path[45];     /* path to file */
  86.                    char free;         /* flag:  1=FREE, 0=Normal Download */
  87.                    long size;         /* size of file in bytes */
  88.                    };
  89.  
  90.                  This file will be created if not found and appended to
  91.                  if it already exists.  The path will always be the
  92.                  parameter used for directory2.  The program will copy
  93.                  the files into this directory.
  94.  
  95.                  This option assumes the following:
  96.  
  97.                      you have the logical USER: assigned to the
  98.                      directory and there is a subdirectory called
  99.                      user:"user name", made from the first parameter
  100.                      and "user:" where the Batch.File can be created
  101.                      or found.
  102.  
  103.  
  104.       There are two other items the program uses if they are defined.
  105.       These are environment variables.
  106.  
  107.       FTP_BBS_NAME     - This will be used to display a welcome message as
  108.                          if the user is on an internet site.
  109.                          You do not have to have it, the program will
  110.                          supply a default.
  111.  
  112.       FTP_SITE_NAME    - This will be used to display the name you chose for
  113.                          your ftp site.  You do not have to have it, the
  114.                          program will supply a default.
  115.  
  116.       FTP_REGISTRATION - This is your registration key, it must match the
  117.                          FTP_BBS_NAME.  This will be supplied to you
  118.                          after your registration fee is received.
  119.  
  120.       FTP_LOG_FILE     - This is an optional name that will define a log
  121.                          file which will show how active the door was and
  122.                          what user made use of it.  This is just a file
  123.                          name.  If not defined, no log is kept.
  124.  
  125.       Define these with the command: "setenv FTP_BBS_NAME "my.bbs.name"
  126.  
  127.   I also recommend you create a room attached to directory2 and put the
  128.   USER.DOC file in there.  That will allow users to examine the door
  129.   commands.
  130.  
  131. Warranty
  132.  
  133.   30 seconds, 30 feet which ever comes first.
  134.  
  135.   If you have a problem, feel free to email me at apreston@isd.csc.com
  136.   or post it on your nearest Citadel in either the Citadel 68K, or
  137.   Sysop Only room.  You can also sent mail to
  138.  
  139.    tony preston@The Amiga Zone.NJ
  140.  
  141.   This is a STDIO door, it can be used with BBSes like DLG, and others
  142.   which have interfaces for that type of door.  If you do use this with
  143.   another type of BBS other than a Citadel, please send me the information
  144.   when you register so I can include it with the next update.
  145.  
  146.  
  147. Registration:  The door has no real restrictions except that the
  148.   unregistered version will remind your users that it is not registered
  149.   each time they move down a directory.  This reminder will slow them
  150.   up, but is harmless.  They will have to hit a return.
  151.  
  152.   The registration will get you a customized version key in the mail.
  153.   This will remove the limitations place on the unregistered version.
  154.  
  155.   Send $10 to:
  156.  
  157.     Custom Services
  158.     P. O. Box 254
  159.     Moorestown, NJ 08055
  160.  
  161.   Send Your Site Name and BBS Name exactly as you have them in the
  162.   environment variables mentioned above.  You are limited to 20 characters
  163.   for these names.
  164.  
  165.   Note: the registration key is controled by an environment variable.
  166.   If an incorrect value is registered, the users will experience a
  167.   10 second delay after an error message which says:
  168.  
  169.   ERROR: registration key error, auto delay activated
  170.  
  171.   This only occurs if the key value and your BBS name do not match.
  172. Future Plans:
  173.  
  174.   The door's GET command currently uses a COPY to move the files.  The
  175.   plan is to give the sysop more flexibilty and input the command used
  176.   with the default being the current COPY command.
  177.  
  178.   Give the ability for the user to specify a path name such as:
  179.  
  180.   Cd Aminet/Dev/c
  181.  
  182.   instead of
  183.  
  184.   Cd Aminet
  185.   Cd Dev
  186.   Cd c
  187.  
  188.   This will also include the usage of ".." and "/" as psuedonyms for
  189.   the parent directory.  This will still protect the Sysop in that
  190.   attempting to Cd above the top directory will exit the door.
  191.  
  192.  
  193.   Other commands have been suggested and will be added to the program
  194.   as time permits.
  195.  
  196.  Contents:
  197.  
  198.    The archive you have should have the following files:
  199.  
  200.    ftp.doc       This file you are reading.
  201.    user.doc      some simple user docs
  202.    ftp           68000 version
  203.    ftp.030       68030 version
  204.  
  205.  
  206.  History:
  207.  
  208.    Beta 1.0-1.03 - Initial release for testing.
  209.  
  210.    1.04Beta      - Added commands(LIST, "?")
  211.                    fixed bug in CD .. and CD / (did not work)
  212.                    fixed bug in VIEW, LIST, CD and DIR
  213.                    where error messages would come out even if
  214.                    ok.
  215.    2.00
  216.  
  217.    -- Supports LHA, LZH, LZ, Zoo, Zip, and ARC files with the VIEW command.
  218.       It will allow you to view the contents of an archive(similar to doing
  219.       LHA V FILE).
  220.    -- Supports limited wildcarding.  The "?" matches any character, the
  221.       "*" matches the rest of the string.  Using the "*" with "Sa*" matches
  222.       all files starting with the letters "Sa".  It is limited in that you
  223.       cannot match on "Sa*.lha" and only get the lha files starting with "Sa".
  224.    -- Supports sorting the directory information.  All lists will come out
  225.       in alphabetical order.
  226.    -- Now uses case sensitive names, like real unix would.
  227.    -- Supports both ".." and "/" as diretory names with the CD.  Both will
  228.       move up one level.
  229.    -- Command line supports directory names with or without the slash on
  230.       the end.  Previous version did not check for proper names.
  231.    -- Several minor bug fixes included.
  232.    -- 68030 optimized version include in the archive along with the
  233.       standard 68000 version.
  234.  
  235.    2.10
  236.  
  237.    -- Added the commands CASE to toggle the case sensitivity, C-ON to
  238.       force case sensitivity, COFF to turn off case sensitivity, and
  239.       STAT to display the current status information.
  240.    -- Added some meaningless statistics and a means for the SYSOP to
  241.       record them to a log file.
  242.    -- Added a new environment variable FTP_REGISTRATION which will allow
  243.       the registered version to be distributed and only a key needed to
  244.       unlock it.
  245.  
  246.    2.11
  247.  
  248.    -- Fixed a bug in the compare routine.  The very last character of
  249.       two names would not be compared if the names matched up to that
  250.       point.  A name like D300 matched D301.  This is fixed.
  251.  
  252.  
  253.    2.12 - 2.13
  254.  
  255.    -- Added the DLG/FREE flag to create the tagged files list for the
  256.       DLG BBS.
  257.